1. GET /partyInteraction
This operation list or find PartyInteraction entities.
URL
https://[host]:[port]/dxp-ux/v1/{businessId}/partyInteraction
URL PARAMS
| name | type | description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (PA etc.) identifying the business unit. | Y |
| name | value | description | required |
|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
Query Params
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|
| interactionItem.item.id | string | unique identifier of the account. | Y(PA) |
| interactionItem.item.@referredType | string | Defines the type of interactionItem.item.id | Y(PA) |
Data Model
Response Data Model
| name | type | description | required (mandatory-Y, optional-N, Not applicable-N/A) |
|---|
| interactionDate | object | Time period during which the interaction occurred. | N |
| interactionDate.startDateTime | datetime | Start date and time of the interaction. | N |
| description | string | Description of the interaction. | N |
| reason | string | Reason why the interaction happened. | N |
| status | string | Status of the interaction. | N |
| direction | string | Indicates who initiated the interaction (inbound or outbound). | N |
| channel | array | List of channels through which the interaction occurred. | N |
| channel[].name | string | Name of the interaction channel. | N |
| channel[].id | string | Id of the interaction channel. | N |
| channel[].href | string | href of the interaction channel. | N |
| interactionItem | array | Collection of interaction items associated with the interaction. | N |
| interactionItem[].item | object | Referenced business entity associated with the interaction item. | N |
| interactionItem[].item.@type | string | Type of the referenced entity. | N |
| interactionItem[].item.@referredType | string | Actual type of the referenced resource. | N |
| interactionItem[].item.id | string | Unique identifier of the referenced entity. | N |
| interactionItem[].item.role | string | Business role of the referenced entity. | N |
| interactionItem[].note | array | Notes associated with the interaction item. | N |
| interactionItem[].note[].text | string | Additional information or comments related to the interaction item. | N |
| @type | string | Type of the interaction resource. | N |
Key considerations
Key Considerations for PA:
- The GET /partyInteraction API is used to retrieve the Percentage Discount information based on the Pricing Plan and Fixed Dollar Discount applied to the customer's account.
- creationDate: Indicates the date when the discount was applied to the customer's account.
- description: Provides details about the account-level discount that was granted.
- reason: Displays a short name or code representing the discount type.
- interactionItem[].item: Identifies the billing account to which the discount applies.
- interactionItem[].note[].text: Shows the pricing plan name and the fixed discount amount applied to the customer's account.